API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

coordinate_locations

Creates a coordinate_locations resource.

Creates a coordinate_locations resource.

Authorizations:
JWT
path Parameters
id
required
string

coordinate_locations identifier

Request Body schema:
required

The new coordinate_locations resource

coordinates
string or null <iri-reference>

Get coordinates.

shipment
string or null <iri-reference>
task
string or null <iri-reference>
address
string or null
suite
string or null
road
string or null
city
string or null
state
string or null
Default: "QC"
country
required
string
Default: "CANADA"
postalCode
string or null
timeZone
string or null
note
string or null
owningCorporation
string <iri-reference>
taxCustoms
Array of strings <iri-reference> [ items <iri-reference > ]
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
adress
string

Get adress.

timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "coordinates": "https://example.com/",
  • "shipment": "https://example.com/",
  • "task": "https://example.com/",
  • "address": "string",
  • "suite": "string",
  • "road": "string",
  • "city": "string",
  • "state": "QC",
  • "country": "CANADA",
  • "postalCode": "string",
  • "timeZone": "string",
  • "note": "string",
  • "owningCorporation": "https://example.com/",
  • "taxCustoms": [],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "adress": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shipment": {
    },
  • "task": {
    },
  • "address": "string",
  • "suite": "string",
  • "road": "string",
  • "city": "string",
  • "state": "QC",
  • "country": "CANADA",
  • "postalCode": "string",
  • "timeZone": "string",
  • "note": "string",
  • "owningCorporation": {
    },
  • "taxCustoms": [
    ],
  • "shortcode": "CRL",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "locationFullAddress": "string",
  • "locationGMapsQueryString": "string",
  • "coordinatesListing": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}